Developer Documentation

QuickTime 4 API Documentation

Inside Macintosh: QuickTime

Previous | Overview | Contents

Movie Toolbox Constants

#define kFix1   =       (0x00010000);       /* fixed point value equal to 1.0 */

#define gestaltQuickTime 'qtim'                     /* Movie Toolbox availability */
#define MovieFileType 'MooV'                        /* movie file type */
#define VideoMediaType 'vide'                       /* video media type */
#define SoundMediaType 'soun'                       /* sound media type */
#define MediaHandlerType 'mhlr'                     /* media handler type */
#define DataHandlerType 'dhlr'                      /* data handler type */
#define TextMediaType 'text'                        /* text media type */
#define GenericMediaType 'gnrc'                     /* base media handler type */

#define DoTheRightThing = 0L                        /* indicates default flag settings
                                                         for Movie Toolbox functions */

/* sound volume values in trackVolume parameter of NewMovieTrack function */
#define kFullVolume         = 0x100                 /* full, natural volume
                                                         (8.8 format) */
#define kNoVolume           =   0                   /* no volume */
/*
    constants for whichMediaTypes parameter of GetMovieNextInterestingTime
    function
*/
#define VisualMediaCharacteristic 'eyes'/* visual media */
#define AudioMediaCharacteristic 'ears' /* audio media */
enum
{
/* media quality settings in quality parameter of SetMediaQuality function */
    mediaQualityDraft           = 0x0000,           /* lowest quality level */
    mediaQualityNormal          = 0x0040,           /* acceptable quality level */
    mediaQualityBetter          = 0x0080,           /* better quality level */
    mediaQualityBest            = 0x00C0        /* best quality level */
};
enum
{
/*
    values for callBackFlags field of QuickTime callback header structure used
    by clock components to communicate scheduling information about a
    callback event to the Movie Toolbox
*/
    qtcbNeedsRateChanges                = 1,    /* rate changes */
    qtcbNeedsTimeChanges                = 2,    /* time changes */
    qtcbNeedsStartStopChanges           = 4     /* time base changes at start &
                                                     stop times */
};
enum
{
/*
    dialog items to include in dialog box definition for use with
    SFPGetFilePreview function
*/
    sfpItemPreviewAreaUser                  = 11,       /* user preview area */
    sfpItemPreviewStaticText                = 12,       /* static text preview */
    sfpItemPreviewDividerUser               = 13,       /* user divider preview */
    sfpItemCreatePreviewButton              = 14,       /* create preview button */
    sfpItemShowPreviewButton                = 15        /* show preview button */
};
enum
{                       
    movieInDataForkResID = -1           /* magic resource ID */
};
enum
{
/* flags for LoadIntoRAM functions */
    keepInRam                       = 1<<0,         /* load and make so data cannot be
                                                        purged */
    unkeepInRam                     = 1<<1,         /* mark data so it can be purged */
    flushFromRam                    = 1<<2,         /* empty handles and purge data from
                                                        memory */
    loadForwardTrackEdits           = 1<<3,         /* load only data around
                                                        track edits--play movie forward */
    loadBackwardTrackEdits          = 1<<4          /* load only data around edits--
                                                        play movie in reverse */
};
enum
{
/* flag for PasteHandleIntoMovie function */
    pasteInParallel = 1         /* changes function to take contents and type of
                                     handle and add to movie */
};
/* text description display flags used in TextMediaAddTextSample and TextMediaAddTESample */
enum
{
    dfDontDisplay               = 1<<0,         /* don't display the text */
    dfDontAutoScale             = 1<<1,         /* don't scale text as track bounds grows
                                                    or shrinks */
    dfClipToTextBox             = 1<<2,         /* clip update to the text box */
    dfUseMovieBGColor           = 1<<3,         /* set text background to movie's
                                                    background color */
    dfShrinkTextBoxToFit        = 1<<4,         /* compute minimum box to fit the
                                                    sample */
    dfScrollIn                  = 1<<5,         /* scroll text in until last of text is
                                                    in view */
    dfScrollOut                 = 1<<6          /* scroll text out until last of text is
                                                    gone (if dfScrollIn is also set,
                                                    scroll in then out */
    dfHorizScroll               = 1<<7,         /* scroll text horizontally--otherwise,
                                                    it's vertical */
    dfReverseScroll             = 1<<8          /* vertically scroll down and
                                                    horizontally scroll
                                                    up--justification-dependent */
};
/* find flags for TextMediaFindNextText function */
    findTextEdgeOK                  = 1<<0,     /* OK to find text at specified
                                                     sample time */
    findTextCaseSensitive           = 1<<1,     /* case-sensitive search */
    findTextReverseSearch           = 1<<2,     /* search from sampleTime backward */
    findTextWraparound              = 1<<3,     /* wrap search when beginning or end
                                                     of movie is reached */
/* return display flags for application-defined text function */
enum
{
    txtProcDefaultDisplay           = 0,        /* use the media's default settings */
    txtProcDontDisplay              = 1,        /* don't display the text */
    txtProcDoDisplay                = 2         /* display the text */
};
enum
{
hintsScrubMode                      = 1<<0,    /* toolbox can display key frames when
                                                     movie is repositioned */
hintsAllowInterlace                 = 1<<6,     /* use interlace option for compressor
                                                     components */
hintsUseSoundInterp              = 1<<7      /* turn on sound interpolation */
};
typedef unsigned long playHintsEnum;

Result Codes

couldNotResolveDataRef

-2000

Cannot use this data reference

badImageDescription

-2001

Problem with this image description

badPublicMovieAtom

-2002

Movie file corrupted

cantFindHandler

-2003

Cannot locate this handler

cantOpenHandler

-2004

Cannot open this handler

badComponentType

-2005

Component cannot accommodate this data

noMediaHandler

-2006

Media has no media handler

noDataHandler

-2007

Media has no data handler

invalidMedia

-2008

This media is corrupted or invalid

invalidTrack

-2009

This track is corrupted or invalid

invalidMovie

-2010

This movie is corrupted or invalid

invalidSampleTable

-2011

This sample table is corrupted or invalid

invalidDataRef

-2012

This data reference is invalid

invalidHandler

-2013

This handler is invalid

invalidDuration

-2014

This duration value is invalid

invalidTime

-2015

This time value is invalid

cantPutPublicMovieAtom

-2016

Cannot write to this movie file

badEditList

-2017

The track's edit list is corrupted

mediaTypesDontMatch

-2018

These media don't match

progressProcAborted

-2019

Your progress procedure returned an error

movieToolboxUninitialized

-2020

You haven't initialized the Movie Toolbox

wfFileNotFound

-2021

Cannot locate this file

cantCreateSingleForkFile

-2022

Error trying to create a single-fork file. This occurs when the file already exists.

invalidEditState

-2023

This edit state is invalid

nonMatchingEditState

-2024

This edit state is not valid for this movie

staleEditState

-2025

Movie or track has been disposed

userDataItemNotFound

-2026

Cannot locate this user data item

maxSizeToGrowTooSmall

-2027

Maximum size must be larger

badTrackIndex

-2028

This track index value is not valid

trackIDNotFound

-2029

Cannot locate a track with this ID value

trackNotInMovie

-2030

This track is not in this movie

timeNotInTrack

-2031

This time value is outside of this track

timeNotInMedia

-2032

This time value is outside of this media

badEditIndex

-2033

This edit index value is not valid

internalQuickTimeError

-2034

Internal error

cantEnableTrack

-2035

Cannot enable this track

invalidRect

-2036

Specified rectangle has invalid coordinates

invalidSampleNum

-2037

There is no sample with this sample number

invalidChunkNum

-2038

There is no chunk with this chunk number

invalidSampleDescIndex

-2039

Sample description index value invalid

invalidChunkCache

-2040

The chunk cache is corrupted

invalidSampleDescription

-2041

This sample description is invalid or corrupted

dataNotOpenForRead

-2042

Cannot read from this data source

dataNotOpenForWrite

-2043

Cannot write to this data source

dataAlreadyOpenForWrite

-2044

Data source is already open for write

dataAlreadyClosed

-2045

You have already closed this data source

endOfDataReached

-2046

End of data

dataNoDataRef

-2047

No data reference value found

noMovieFound

-2048

Toolbox cannot find a movie in the movie file

invalidDataRefContainer

-2049

Invalid data reference

badDataRefIndex

-2050

Data reference index value is invalid

noDefaultDataRef

-2051

Could not find a default data reference

couldNotUseAnExistingSample

-2052

Movie Toolbox could not use a sample

featureUnsupported

-2053

Movie Toolbox does not support this feature


© 1998 Apple Computer, Inc.

| Previous | Overview | Contents |